Skip to main content
GET

​
Overview

This endpoint lists every batch created by the authenticated user with pagination and search support. Only non-deleted batches are returned by default. Use this to monitor active campaigns, view batch summaries, and track campaign statistics.

​
Prerequisites

  • Bearer token for an authenticated user.
  • The user must own the batches being retrieved.

​
Request

​
string
required
Bearer token for the authenticated user.
​
string
required
User identifier. The authenticated user must match this ID.
​
integer
default:"1"
Page number for pagination.
​
integer
default:"10"
Number of batches to return per page (default: 10).
​
string
Search term to filter batches by batchName or queue_status.

​
Response

​
object
required
Contains the batches array and pagination metadata.
​
array[object]
required
Array of batch records with summary statistics.
​
string
required
Unique identifier for the batch.
​
string
required
Display name for the batch.
​
integer
required
Total number of calls in the batch.
​
integer
required
Number of calls that were picked up/answered.
​
integer
required
Number of calls that completed successfully.
​
string
required
Current status of the batch queue (e.g., “active”, “paused”, “completed”).
​
string
required
Timestamp when the batch was created (ISO 8601 format).
​
string
required
Timestamp when the batch was last updated (ISO 8601 format).
​
object
required
Pagination metadata.
​
integer
required
Total number of batches matching the search criteria.
​
integer
required
Current page number.
​
integer
required
Number of records per page.
​
integer
required
Total number of pages available.

​
Error Handling

  • 400 Bad Request – Invalid userId format or invalid query parameters.
  • 404 Not Found – No batches found for the authenticated user.
  • 500 Internal Server Error – Failed to fetch batch data; retry or contact support.
Filtering Behavior:
  • Only non-deleted batches are returned (isDeleted: false)
  • Use the search parameter to filter by batch name or queue status
  • Results are sorted by creation date in descending order (newest first)
  • Pagination helps manage large lists of batches efficiently
Combine this endpoint with GET /api/call/batch-details/{id} to first get an overview of all batches, then drill down into specific batch details.

Authorizations

​
Authorization
string
header
required

Bearer token authentication for workspace access

Path Parameters

​
userId
string
required

Query Parameters

​
page
integer
default:1
​
limit
integer
default:10
​
search
string

Response

Batches fetched successfully